home *** CD-ROM | disk | FTP | other *** search
/ IRIX Base Documentation 1998 November / IRIX 6.5.2 Base Documentation November 1998.img / usr / share / catman / p_man / cato / Xm / XmArrowButtonGadget.z / XmArrowButtonGadget
Text File  |  1998-10-20  |  21KB  |  331 lines
  1.  
  2.  
  3.  
  4.      XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))   UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV   XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  5.  
  6.  
  7.  
  8.      NNNNAAAAMMMMEEEE
  9.           XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt - The ArrowButtonGadget widget class
  10.  
  11.      SSSSYYYYNNNNOOOOPPPPSSSSIIIISSSS
  12.           ####iiiinnnncccclllluuuuddddeeee <<<<XXXXmmmm////AAAArrrrrrrroooowwwwBBBBGGGG....hhhh>>>>
  13.  
  14.  
  15.      VVVVEEEERRRRSSSSIIIIOOOONNNN
  16.           This page documents version 1.2 of the Motif library.
  17.  
  18.      DDDDEEEESSSSCCCCRRRRIIIIPPPPTTTTIIIIOOOONNNN
  19.           ArrowButtonGadget consists of a directional arrow surrounded
  20.           by a border shadow.  When it is selected, the shadow changes
  21.           to give the appearance that the ArrowButtonGadget has been
  22.           pressed in.  When it is unselected, the shadow reverts to
  23.           give the appearance that the button is released, or out.
  24.  
  25.         CCCCllllaaaasssssssseeeessss
  26.           ArrowButtonGadget inherits behavior and resources from
  27.           OOOObbbbjjjjeeeecccctttt, RRRReeeeccccttttOOOObbbbjjjj, and XXXXmmmmGGGGaaaaddddggggeeeetttt classes.
  28.  
  29.           The class pointer is xxxxmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeettttCCCCllllaaaassssssss.
  30.  
  31.           The class name is XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt.
  32.  
  33.         NNNNeeeewwww RRRReeeessssoooouuuurrrrcccceeeessss
  34.           The following table defines a set of widget resources used
  35.           by the programmer to specify data.  The programmer can also
  36.           set the resource values for the inherited classes to set
  37.           attributes for this widget.  To reference a resource by name
  38.           or by class in a .Xdefaults file, remove the XXXXmmmmNNNN or XXXXmmmmCCCC
  39.           prefix and use the remaining letters.  To specify one of the
  40.           defined values for a resource in a .Xdefaults file, remove
  41.           the XXXXmmmm prefix and use the remaining letters (in either
  42.           lowercase or uppercase, but include any underscores between
  43.           words).  The codes in the access column indicate if the
  44.           given resource can be set at creation time (C), set by using
  45.           XXXXttttSSSSeeeettttVVVVaaaalllluuuueeeessss (S), retrieved by using XXXXttttGGGGeeeettttVVVVaaaalllluuuueeeessss (G), or is
  46.           not applicable (N/A).
  47.  
  48.                              AAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  49.      NNNNaaaammmmeeee                  CCCCllllaaaassssssss               TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt      AAAAcccccccceeeessssssss
  50.      ______________________________________________________________________________
  51.      XmNactivateCallback   XmCCallback         XtCallbackList   NULL         C
  52.      XmNarmCallback        XmCCallback         XtCallbackList   NULL         C
  53.      XmNarrowDirection     XmCArrowDirection   unsigned char    XmARROW_UP   CSG
  54.      XmNdisarmCallback     XmCCallback         XtCallbackList   NULL         C
  55.      XmNmultiClick         XmCMultiClick       unsigned char    dynamic      CSG
  56.  
  57.  
  58.           XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk
  59.                     Specifies a list of callbacks that is called when
  60.  
  61.  
  62.  
  63.      Page 1                                          (printed 4/30/98)
  64.  
  65.  
  66.  
  67.  
  68.  
  69.  
  70.      XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))   UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV   XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  71.  
  72.  
  73.  
  74.                     the ArrowButtonGadget is activated.  To activate
  75.                     the button, press and release BBBBSSSSeeeelllleeeecccctttt while the
  76.                     pointer is inside the ArrowButtonGadget.
  77.                     Activating the ArrowButtonGadget also disarms it.
  78.                     The reason sent by this callback is XXXXmmmmCCCCRRRR____AAAACCCCTTTTIIIIVVVVAAAATTTTEEEE.
  79.  
  80.           XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
  81.                     Specifies a list of callbacks that is called when
  82.                     the ArrowButtonGadget is armed.  To arm this
  83.                     widget, press BBBBSSSSeeeelllleeeecccctttt while the pointer is inside
  84.                     the ArrowButtonGadget.  The reason sent by this
  85.                     callback is XXXXmmmmCCCCRRRR____AAAARRRRMMMM.
  86.  
  87.           XXXXmmmmNNNNaaaarrrrrrrroooowwwwDDDDiiiirrrreeeeccccttttiiiioooonnnn
  88.                     Sets the arrow direction.  The values for this
  89.                     resource are:
  90.  
  91.  
  92.                       +o  XXXXmmmmAAAARRRRRRRROOOOWWWW____UUUUPPPP.
  93.  
  94.                       +o  XXXXmmmmAAAARRRRRRRROOOOWWWW____DDDDOOOOWWWWNNNN.
  95.  
  96.                       +o  XXXXmmmmAAAARRRRRRRROOOOWWWW____LLLLEEEEFFFFTTTT.
  97.  
  98.                       +o  XXXXmmmmAAAARRRRRRRROOOOWWWW____RRRRIIIIGGGGHHHHTTTT.
  99.  
  100.  
  101.           XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk
  102.                     Specifies a list of callbacks that is called when
  103.                     the ArrowButtonGadget is disarmed.  To disarm this
  104.                     widget, press and release BBBBSSSSeeeelllleeeecccctttt while the
  105.                     pointer is inside the ArrowButtonGadget.  The
  106.                     reason sent by this callback is XXXXmmmmCCCCRRRR____DDDDIIIISSSSAAAARRRRMMMM.
  107.  
  108.           XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk
  109.                     If a button click is followed by another button
  110.                     click within the time span specified by the
  111.                     display's multi-click time, and this resource is
  112.                     set to XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____DDDDIIIISSSSCCCCAAAARRRRDDDD, do not process the
  113.                     second click.  If this resource is set to
  114.                     XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP, process the event and increment
  115.                     _c_l_i_c_k__c_o_u_n_t in the callback structure.  When the
  116.                     ArrowButtonGadget is not in a menu, the default
  117.                     value is XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP.
  118.  
  119.  
  120.         IIIInnnnhhhheeeerrrriiiitttteeeedddd RRRReeeessssoooouuuurrrrcccceeeessss
  121.           ArrowButtonGadget inherits behavior and resources from the
  122.           following superclasses.  For a complete description of each
  123.           resource, refer to the man page for that superclass.
  124.  
  125.                                     XXXXmmmmGGGGaaaaddddggggeeeetttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  126.  
  127.  
  128.  
  129.      Page 2                                          (printed 4/30/98)
  130.  
  131.  
  132.  
  133.  
  134.  
  135.  
  136.      XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))   UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV   XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  137.  
  138.  
  139.  
  140.      NNNNaaaammmmeeee                    CCCCllllaaaassssssss                   TTTTyyyyppppeeee               DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  141.      ___________________________________________________________________________________
  142.      XmNbottomShadowColor    XmCBottomShadowColor    Pixel              dynamic   G
  143.      XmNhelpCallback         XmCCallback             XtCallbackList     NULL      C
  144.      XmNhighlightColor       XmCHighlightColor       Pixel              dynamic   G
  145.      XmNhighlightOnEnter     XmCHighlightOnEnter     Boolean            False     CSG
  146.      XmNhighlightThickness   XmCHighlightThickness   Dimension          2         CSG
  147.      XmNnavigationType       XmCNavigationType       XmNavigationType   XmNONE    CSG
  148.      XmNshadowThickness      XmCShadowThickness      Dimension          2         CSG
  149.      XmNtopShadowColor       XmCTopShadowColor       Pixel              dynamic   G
  150.      XmNtraversalOn          XmCTraversalOn          Boolean            True      CSG
  151.      XmNunitType             XmCUnitType             unsigned char      dynamic   CSG
  152.      XmNuserData             XmCUserData             XtPointer          NULL      CSG
  153.  
  154.                               RRRReeeeccccttttOOOObbbbjjjj RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  155.       NNNNaaaammmmeeee                   CCCCllllaaaassssssss            TTTTyyyyppppeeee        DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  156.       ____________________________________________________________________
  157.       XmNancestorSensitive   XmCSensitive     Boolean     dynamic   G
  158.       XmNborderWidth         XmCBorderWidth   Dimension   0         CSG
  159.       XmNheight              XmCHeight        Dimension   dynamic   CSG
  160.       XmNsensitive           XmCSensitive     Boolean     True      CSG
  161.       XmNwidth               XmCWidth         Dimension   dynamic   CSG
  162.       XmNx                   XmCPosition      Position    0         CSG
  163.       XmNy                   XmCPosition      Position    0         CSG
  164.  
  165.                               OOOObbbbjjjjeeeecccctttt RRRReeeessssoooouuuurrrrcccceeee SSSSeeeetttt
  166.       NNNNaaaammmmeeee                 CCCCllllaaaassssssss         TTTTyyyyppppeeee             DDDDeeeeffffaaaauuuulllltttt   AAAAcccccccceeeessssssss
  167.       ____________________________________________________________________
  168.       XmNdestroyCallback   XmCCallback   XtCallbackList   NULL      C
  169.  
  170.         CCCCaaaallllllllbbbbaaaacccckkkk IIIInnnnffffoooorrrrmmmmaaaattttiiiioooonnnn
  171.           A pointer to the following structure is passed to each
  172.           callback:
  173.  
  174.           ttttyyyyppppeeeeddddeeeeffff ssssttttrrrruuuucccctttt
  175.           {{{{
  176.             iiiinnnntttt      _r_e_a_s_o_n;;;;
  177.             XXXXEEEEvvvveeeennnntttt   * _e_v_e_n_t;;;;
  178.             iiiinnnntttt      _c_l_i_c_k__c_o_u_n_t;;;;
  179.           }}}} XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnCCCCaaaallllllllbbbbaaaacccckkkkSSSSttttrrrruuuucccctttt;;;;
  180.  
  181.  
  182.           _r_e_a_s_o_n Indicates why the callback was invoked.
  183.  
  184.           _e_v_e_n_t  Points to the XXXXEEEEvvvveeeennnntttt that triggered the callback.
  185.  
  186.           _c_l_i_c_k__c_o_u_n_t
  187.                  This value is valid only when the reason is
  188.                  XXXXmmmmCCCCRRRR____AAAACCCCTTTTIIIIVVVVAAAATTTTEEEE.  It contains the number of clicks in
  189.                  the last multiclick sequence if the XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk
  190.                  resource is set to XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP, otherwise it
  191.                  contains 1111.  The activate callback is invoked for
  192.  
  193.  
  194.  
  195.      Page 3                                          (printed 4/30/98)
  196.  
  197.  
  198.  
  199.  
  200.  
  201.  
  202.      XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))   UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV   XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  203.  
  204.  
  205.  
  206.                  each click if XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is set to
  207.                  XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP.
  208.  
  209.  
  210.         BBBBeeeehhhhaaaavvvviiiioooorrrr
  211.           XmArrowButtonGadget includes behavior from XmGadget.
  212.           Additional XmArrowButtonGadget behavior is described below:
  213.  
  214.  
  215.           BBBBSSSSeeeelllleeeecccctttt PPPPrrrreeeessssssss:
  216.                     Draws the shadow in the selected state and calls
  217.                     the callbacks for XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk.
  218.  
  219.           BBBBSSSSeeeelllleeeecccctttt CCCClllliiiicccckkkk oooorrrr BBBBSSSSeeeelllleeeeccccttttRRRReeeelllleeeeaaaasssseeee:
  220.                     Draws the shadow in the unselected state.  If the
  221.                     pointer is within the ArrowButtonGadget, calls the
  222.                     callbacks for XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk.  Calls the
  223.                     callbacks for XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk.
  224.  
  225.           BBBBSSSSeeeelllleeeecccctttt PPPPrrrreeeessssssss 2222++++:
  226.                     If XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____DDDDIIIISSSSCCCCAAAARRRRDDDD, this
  227.                     action does nothing.  If XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is
  228.                     XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP, this action draws the shadow in
  229.                     the selected state and calls the callbacks for
  230.                     XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk.
  231.  
  232.           BBBBSSSSeeeelllleeeecccctttt RRRReeeelllleeeeaaaasssseeee 2222++++:
  233.                     If XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____DDDDIIIISSSSCCCCAAAARRRRDDDD, this
  234.                     action does nothing.
  235.  
  236.                     If XXXXmmmmNNNNmmmmuuuullllttttiiiiCCCClllliiiicccckkkk is XXXXmmmmMMMMUUUULLLLTTTTIIIICCCCLLLLIIIICCCCKKKK____KKKKEEEEEEEEPPPP, this action
  237.                     does the following:  Increments _c_l_i_c_k__c_o_u_n_t in the
  238.                     callback structure.  Draws the shadow in the
  239.                     unselected state.  If the pointer is within the
  240.                     ArrowButtonGadget, calls the callbacks for
  241.                     XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk.  Calls the callbacks for
  242.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk.
  243.  
  244.           KKKKSSSSeeeelllleeeecccctttt:  Draws the shadow in the selected state and calls
  245.                     the callbacks for XXXXmmmmNNNNaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk.  Arranges for
  246.                     the shadow to be drawn in the unselected state and
  247.                     the callbacks for XXXXmmmmNNNNaaaaccccttttiiiivvvvaaaatttteeeeCCCCaaaallllllllbbbbaaaacccckkkk and
  248.                     XXXXmmmmNNNNddddiiiissssaaaarrrrmmmmCCCCaaaallllllllbbbbaaaacccckkkk to be called, either immediately
  249.                     or at a later time.
  250.  
  251.           KKKKHHHHeeeellllpppp:    Calls the callbacks for XXXXmmmmNNNNhhhheeeellllppppCCCCaaaallllllllbbbbaaaacccckkkk if any
  252.                     exist.  If there are no help callbacks for this
  253.                     widget, this calls the help callbacks for the
  254.                     nearest ancestor that has them.
  255.  
  256.           <<<<EEEEnnnntttteeeerrrr>>>>:  Draws the ArrowButtonGadget shadow in its selected
  257.                     state if the pointer leaves and re-enters the
  258.  
  259.  
  260.  
  261.      Page 4                                          (printed 4/30/98)
  262.  
  263.  
  264.  
  265.  
  266.  
  267.  
  268.      XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))   UUUUNNNNIIIIXXXX SSSSyyyysssstttteeeemmmm VVVV   XXXXmmmmAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX))))
  269.  
  270.  
  271.  
  272.                     gadget while BSelect is pressed.
  273.  
  274.           <<<<LLLLeeeeaaaavvvveeee>>>>:  Draws the ArrowButtonGadget shadow in its
  275.                     unselected state if the pointer leaves the gadget
  276.                     while BSelect is pressed.
  277.  
  278.  
  279.         VVVViiiirrrrttttuuuuaaaallll BBBBiiiinnnnddddiiiinnnnggggssss
  280.           The bindings for virtual keys are vendor specific.  For
  281.           information about bindings for virtual buttons and keys, see
  282.           VVVViiiirrrrttttuuuuaaaallllBBBBiiiinnnnddddiiiinnnnggggssss((((3333XXXX)))).
  283.  
  284.      RRRREEEELLLLAAAATTTTEEEEDDDD IIIINNNNFFFFOOOORRRRMMMMAAAATTTTIIIIOOOONNNN
  285.           OOOObbbbjjjjeeeecccctttt((((3333XXXX)))), RRRReeeeccccttttOOOObbbbjjjj((((3333XXXX)))), XXXXmmmmCCCCrrrreeeeaaaatttteeeeAAAArrrrrrrroooowwwwBBBBuuuuttttttttoooonnnnGGGGaaaaddddggggeeeetttt((((3333XXXX)))), and
  286.           XXXXmmmmGGGGaaaaddddggggeeeetttt((((3333XXXX)))).
  287.  
  288.  
  289.  
  290.  
  291.  
  292.  
  293.  
  294.  
  295.  
  296.  
  297.  
  298.  
  299.  
  300.  
  301.  
  302.  
  303.  
  304.  
  305.  
  306.  
  307.  
  308.  
  309.  
  310.  
  311.  
  312.  
  313.  
  314.  
  315.  
  316.  
  317.  
  318.  
  319.  
  320.  
  321.  
  322.  
  323.  
  324.  
  325.  
  326.  
  327.      Page 5                                          (printed 4/30/98)
  328.  
  329.  
  330.  
  331.